home *** CD-ROM | disk | FTP | other *** search
/ Aminet 37 / Aminet 37 (2000)(Schatztruhe)[!][Jun 2000].iso / Aminet / text / edit / JumpED.readme < prev    next >
Text File  |  2000-05-02  |  5KB  |  170 lines
  1. Short:    Handy Text editor tool, Jump to Labels via List
  2. Author:   Bruce steers <bsteers@btinternet.com>
  3. Uploader: http://www.btinternet.com/~bsteers/
  4. Version:  $VER JumpED 3.3 (21/03/00)
  5. Required: MUI , An Editor with ARexx
  6.  
  7.  
  8. ---------------------------------------------------------------------
  9.  
  10. Intro:
  11. ------
  12.  
  13. JumpED is a tool i wrote because of those times when you load up an
  14. old source code you wrote and then think where the hell's that
  15. function gone ! , and you can't quite remember it's name to use your
  16. Editors Search function :-\
  17.  
  18. Basically JumpED reads through an ascii file and then presents you with
  19. a list of all the files functions..
  20.  
  21. Currently JumpED recognises ARexx , Amiga_E and Guide files .
  22.  
  23. any other files will be searched for ARexx type definitions
  24. ie. the 1st word of a line ends in a ':' character.
  25. eg. this readme will load and list all the nodes :)
  26.  
  27. ---------------------------------------------------------------------
  28.  
  29. Usage:
  30. ------
  31.  
  32. double click WB icon or run with no args to load a doc via file requester
  33. or execute 'JumpED <Filename> quick/s'
  34.  
  35. You double click a browsernode and your editor will automatically
  36. jump to the right line number.
  37.  
  38. you can enter a new name in the string gadget to specify another doc.
  39. also window is an app window so you can drop an icon onto it.
  40.  
  41. Read ; This will read / re-read the document
  42. Prefs ; See Settings below
  43.  
  44. ---------------------------------------------------------------------
  45.  
  46. Settings:
  47. ---------
  48.  
  49. JumpED is set up best to use BED , it also has defaults for GoldED
  50. and DigitalQuill but as i do not use these i haven't made them perfect
  51. but you can edit the commands used for jumping to suit your own editor,
  52. you must know it's ARexx commands.
  53.  
  54. the default BED Settings may look a bit complicated to the novice but set
  55. up this way I can run JumpED at any time (even if doc or Bed are closed)
  56.  
  57. the main Jump settings are ARexx functions
  58.  
  59.   IF YOU GET THIS TO WORK WITH OTHER EDITORS OR IMPROVE THE SETTINGS IN
  60.   ANY WAY , PLEASE SEND ME YOUR envarc:JumpED.Cgf file SO I CAN UPGRADE
  61.                                THE SUPPORT.
  62.  
  63.                                   THANKS
  64.  
  65.  
  66. The ARexx settings are split into 4 parts and are placed in their correct
  67. string gadgets using ';' to separate lines ...
  68.  
  69. here are the defaults for BED
  70.  
  71. (1).  the function to check editor is Running.
  72. note: i use %f to add the filename)
  73.  
  74. -----------------------
  75. if ~show(p,'BED') then do
  76. address command 'run >nil: BED "%f"'
  77. address command 'waitforport BED'
  78. end
  79. -----------------------
  80.  
  81. (2). the function to address the port of the open document
  82. note: the last command actually addresses the port
  83.  
  84. -----------------------
  85. address BED
  86. getdocuments
  87. docs=result
  88. fp='%f'
  89. name=substr(fp,max(lastpos('/',fp),lastpos(':',fp))+1)  --> gets FilePart
  90. if index(docs,name)==0 then opendoc fp
  91. Getport fp
  92. port=RESULT
  93. address value port
  94. -----------------------
  95.  
  96. (3). the function to move to the line
  97.  
  98. -----------------------
  99. move %n CENTER
  100. -----------------------
  101.  
  102. (4). the function to activate the document window (optional)
  103. -----------------------
  104. activatewindow
  105. -----------------------
  106.  
  107. 'Save' saves settings to env: and envarc:
  108. 'Use'  saves settings to env: only
  109. 'Restore' restores settings from
  110. -----------------------
  111.  
  112. Show Line Numbers:
  113. ------------------
  114. This little Checkmark will toggle the showing of the
  115. line numbers in the main list.
  116.  
  117. Quit on Click
  118. -------------
  119. This will quit JumpEd when you double click the list
  120. it's not realy meant for a global setting but more as an argument
  121. passed at startup , eg.. 'Jumped filname quick'.
  122.  
  123.  
  124. ---------------------------------------------------------------------
  125.  
  126.  
  127. TODO:
  128.  
  129. i intend to make this program recognise different file extentions so
  130. it can be used for other file formats,
  131.  
  132. examples.
  133.  
  134.   TYPE     , EXTENTION ,  LABEL SYNTAX
  135. -----------,-----------,---------------
  136. ARexx      , #?rexx#?  , <name>:
  137. Amiga_E    , #?.e      , PROC <name>(
  138. AmigaGuide , #?.guide  , @NODE "<name>"
  139.  
  140. these will be held in the settings file
  141.  
  142. the first definition will be the fallback type.
  143.  
  144. you will be able to alter / add / remove them to your liking,
  145.  
  146.  
  147. ---------------------------------------------------------------------
  148.  
  149.  
  150. please send reports/suggestions/questions to bsteers@btinternet.com
  151.  
  152.  
  153. Bruce Steers <bsteers@btinternet.com>
  154. http://www.btinternet.com/~bsteers/
  155.  
  156.  
  157. ============================= Archive contents =============================
  158.  
  159. Original  Packed Ratio    Date     Time    Name
  160. -------- ------- ----- --------- --------  -------------
  161.      669     288 56.9% 16-Mar-00 02:31:58  JumpED.info
  162.    22288   10001 55.1% 21-Mar-00 00:22:34 +JumpED
  163.     5390    2280 57.6% 21-Mar-00 00:21:06 +JumpED.guide
  164.     2639    1505 42.9% 07-Feb-00 13:07:18 +JumpED.guide.info
  165.      669     282 57.8% 24-Feb-00 23:04:36 +JumpED.info
  166.     4338    1940 55.2% 21-Mar-00 00:20:58 +JumpED.readme
  167.     1383     830 39.9% 07-Feb-00 13:07:18 +JumpED.readme.info
  168. -------- ------- ----- --------- --------
  169.    37376   17126 54.1% 02-Apr-100 14:33:38   7 files
  170.